
<!DOCTYPE html>
<!--

    Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>stop-local-instance</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="css/style.css" rel="stylesheet">
    <script src="https://use.fontawesome.com/96c4d89611.js"></script>
  </head>
  <body>
<table id="doc-title" cellspacing="0" cellpadding="0">
  <tr>
  <td align="left" valign="top">
  <b>stop-local-instance</b><br />
  </td>
  </tr>
</table>
<hr />

<table width="90%" id="top-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>
		<td align="left">
		<a href="stop-instance.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="undeploy.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class=" vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>


<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a id="stop-local-instance-1"></a><a id="GSRFM00242"></a><a id="stop-local-instance"></a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_stop_local_instance">stop-local-instance</h2>
<div class="sectionbody">
<div class="paragraph">
<p>stops a \{product---name} instance on the machine where the subcommand
is run</p>
</div>
<div id="sthref2181" class="paragraph">
<p>Synopsis</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin [asadmin-options] stop-local-instance [--help]
[--nodedir node-dir] [--node node]
[--force={true|false}] [--kill={false|true}]
[instance-name]</code></pre>
</div>
</div>
<div id="sthref2182" class="paragraph">
<p>Description</p>
</div>
<div class="paragraph">
<p>The <code>stop-local-instance</code> subcommand stops a \{product---name} instance
on the machine where the subcommand is run. This subcommand does not
require secure shell (SSH) to be configured. You must run this command
from the machine where the instance resides.</p>
</div>
<div class="paragraph">
<p>The subcommand can stop any \{product---name} instance, regardless of
how the instance was created. For example, this subcommand can stop an
instance that was created by using the
<a href="create-instance.html#create-instance-1"><code>create-instance</code>(1)</a>
subcommand.</p>
</div>
<div class="paragraph">
<p>The <code>stop-local-instance</code> subcommand does not contact the DAS to
determine the node on which the instance resides. To determine the node
on which the instance resides, the subcommand searches the directory
that contains the node directories. If multiple node directories exist,
the node must be specified as an option of the subcommand.</p>
</div>
<div class="paragraph">
<p>This subcommand is supported in local mode.</p>
</div>
<div id="sthref2183" class="paragraph">
<p>Options</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">asadmin-options</dt>
<dd>
<p>Options for the <code>asadmin</code> utility. For information about these
options, see the <a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> help page.</p>
</dd>
<dt class="hdlist1"><code>--help</code></dt>
<dt class="hdlist1"><code>-?</code></dt>
<dd>
<p>Displays the help text for the subcommand.</p>
</dd>
<dt class="hdlist1"><code>--nodedir</code></dt>
<dd>
<p>Specifies the directory that contains the instance&#8217;s node directory.
The instance&#8217;s files are stored in the instance&#8217;s node directory. The
default is as-install`/nodes`.</p>
</dd>
<dt class="hdlist1"><code>--node</code></dt>
<dd>
<p>Specifies the node on which the instance resides. This option may be
omitted only if the directory that the <code>--nodedir</code> option specifies
contains only one node directory. Otherwise, this option is required.</p>
</dd>
<dt class="hdlist1"><code>--force</code></dt>
<dd>
<p>Specifies whether the instance is forcibly stopped immediately.<br>
Possible values are as follows:<br></p>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>true</code></dt>
<dd>
<p>The instance is forcibly stopped immediately (default).</p>
</dd>
<dt class="hdlist1"><code>false</code></dt>
<dd>
<p>The subcommand waits until all threads that are associated with the
instance are exited before stopping the instance.</p>
</dd>
</dl>
</div>
</dd>
<dt class="hdlist1"><code>--kill</code></dt>
<dd>
<p>Specifies whether the instance is killed by using functionality of the
operating system to terminate the instance process.<br>
Possible values are as follows:<br></p>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>false</code></dt>
<dd>
<p>The instance is not killed. The subcommand uses functionality of the
Java platform to terminate the instance process (default).</p>
</dd>
<dt class="hdlist1"><code>true</code></dt>
<dd>
<p>The instance is killed. The subcommand uses functionality of the
operating system to terminate the instance process.</p>
</dd>
</dl>
</div>
</dd>
</dl>
</div>
<div id="sthref2184" class="paragraph">
<p>Operands</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">instance-name</dt>
<dd>
<p>The name of the instance to stop.</p>
</dd>
</dl>
</div>
<div id="sthref2185" class="paragraph">
<p>Examples</p>
</div>
<div class="paragraph">
<p><a id="GSRFM768"></a><a id="sthref2186"></a></p>
</div>
<div class="paragraph">
<p>Example 1   Stopping an Instance Locally</p>
</div>
<div class="paragraph">
<p>This example stops the instance <code>yml-i-sj01</code> on the machine where the
subcommand is run.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; stop-local-instance --node sj01 yml-i-sj01
Waiting for the instance to stop ...
Command stop-local-instance executed successfully.</code></pre>
</div>
</div>
<div id="sthref2187" class="paragraph">
<p>Exit Status</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>command executed successfully</p>
</dd>
<dt class="hdlist1">1</dt>
<dd>
<p>error in executing the command</p>
</dd>
</dl>
</div>
<div id="sthref2188" class="paragraph">
<p>See Also</p>
</div>
<div class="paragraph">
<p><a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a></p>
</div>
<div class="paragraph">
<p><a href="create-instance.html#create-instance-1"><code>create-instance</code>(1)</a>,
<a href="create-local-instance.html#create-local-instance-1"><code>create-local-instance</code>(1)</a>,
<a href="delete-instance.html#delete-instance-1"><code>delete-instance</code>(1)</a>,
<a href="delete-local-instance.html#delete-local-instance-1"><code>delete-local-instance</code>(1)</a>,
<a href="start-instance.html#start-instance-1"><code>start-instance</code>(1)</a>,
<a href="start-local-instance.html#start-local-instance-1"><code>start-local-instance</code>(1)</a>,
<a href="stop-instance.html#stop-instance-1"><code>stop-instance</code>(1)</a></p>
</div>
</div>
</div>

<hr />

<table width="90%" id="bottom-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>		
		<td align="left">
		<a href="stop-instance.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="undeploy.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class="vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>

<span id="copyright">
        <img src="/resource/reference/img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;            
        <span >Copyright&nbsp;&copy;&nbsp;2019,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
</span>

</body>
</html>
